<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	<title>class FormManager</title>
	<style type="text/css">
	/* ZenDoc identity */
	.zendoc { font-family: Arial, Helvetica, sans-serif; margin:3px; }
	.zendoc a:hover { text-decoration:none; }
	.zendoc span.title-comment { font-family: Verdana, Arial, Helvetica, sans-serif; font-size:80%; color:#AAA; }
	.zendoc span.title-zen { color:#26A; font-weight:normal; }
	.zendoc span.title-doc { color:black; font-weight:bold; }
	/* overall */
	html, body, div { margin:0; padding:0; border:none; }
	body { font-family:Arial, Helvetica, sans-serif; font-size:90%; }
	a { text-decoration:none; }
	a:hover { text-decoration:underline; }
	h2 { color:#999; margin:2em 0 0 0; padding:0 2px 0 20px; border-bottom:2px solid #58B; }
	h3 { color:#B36B00; margin-top:3em; }
	dl { margin:.5em 0 3px 0; }
	dt { font-weight:bold; }
	td { vertical-align:top; }
	th { text-align:left; color:#58B; background-color:#E3ECF4; }
	code { font-size:1.1em; }
	/* specific */
	#header { background-color:#EAEAEA; padding:1px; }
	#links { color:#999; background-color:#FFE; border-bottom:1px solid #58B; padding:2px 20px; }
	#links a { color:#999; }
	.content { padding:10px 20px; }
	#class-definition { background-color:#58B; color:white; }
	#class-definition .classkind { font-weight:bold; }
	#class-definition .classkind .package { font-weight:normal; }
	#class-definition .classname { font-size:4em; margin:5px 0; }
	#class-definition .superclassname { padding-left:20px; font-style:italic; }
	#class-definition .implements { padding-left:20px; font-style:italic; }
	#class-info .content { margin:20px; border:1px solid #58B; }
	pre.definition { background-color:#FFE; border:1px solid #E4E29A; padding:3px; }
	.generated {
		font-style:italic;
		font-size:80%;
		color:#666;
		margin:1em 0 0 0;
		padding:5px 20px;
		border-top:1px solid #999;
	}
	/* tables */
	.member-list { border:1px solid #58B; margin:2em 20px; }
	.member-list a { color:#B36B00; }
	.member-list table { border-collapse:collapse; }
	.member-list td { border-top:1px solid #58B; }
	.member-list td.name { width:175px; text-align:right; padding-right:5px; }
	.member-list table { width:100%; }
	.even { background-color:#FFE; }
	.odd { background-color:white; }
	.param .name { color:#666; }
	</style>
</head>

<body>
<div id="page">
	<div id="header">
		<h4 class="zendoc"><a href="http://www.zendoc.org" title="ZenDoc Documentation Tool Home"><span class="title-comment">/**</span><span class="title-zen">Zen</span><span class="title-doc">Doc</span><span class="title-comment">--&gt;</span></a></h4>
	</div>
	<div id="class-definition" class="section">
		<div class="content">
			
			<div class="classkind">class <span class="package"></span></div>
			<h1 class="classname">FormManager</h1>
			
			
			
		</div>
		<div id="links">
			<a href="#class-info">Class Information</a>
			 | <a href="#class-constructors">Constructors</a>
			 | <a href="#class-properties">Properties</a>
			 | <a href="#class-methods">Methods</a>
			
		</div>
	</div>
	
	<div id="class-info" class="section">
		<h2>Class Information</h2>
		<div class="content">
			
				<dl>
					
					
					<dt>Description</dt>
					<dd>FormManager class</dd>
					
					public class FormManager</dd>
					
				</dl>
			
			
			</div>
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Constructors</th></tr>
				<tr class="even">
					<td class="name"><a href="#FormManager">FormManager()</a></td>
					<td>To Create an instance of FormManager</td>
				</tr>
			</table></div>
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Properties</th></tr>
				<tr class="even">
					<td class="name"><a href="#tabulation">tabulation</a></td>
					<td>Enable or disable the automatic tabulation on the form. Default false</td>
				</tr><tr class="odd">
					<td class="name"><a href="#rollOver">rollOver</a></td>
					<td>Enable or disable the rollOver on the questions. Default false</td>
				</tr><tr class="even">
					<td class="name"><a href="#colorShapeFocus">colorShapeFocus</a></td>
					<td>Define a color for the shape focus of the questions</td>
				</tr><tr class="odd">
					<td class="name"><a href="#shapeFocus">shapeFocus</a></td>
					<td>Enable or disable the shape focus when a question take the focus. Default false</td>
				</tr><tr class="even">
					<td class="name"><a href="#buttonConfirm">buttonConfirm</a></td>
					<td>Define the button confirm of the form.</td>
				</tr>
			</table></div>
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Methods</th></tr>
				<tr class="even">
					<td class="name"><a href="#init">init()</a></td>
					<td>Initialize the formManager</td>
				</tr><tr class="odd">
					<td class="name"><a href="#close">close()</a></td>
					<td>Close the form (Disable the tabulation)</td>
				</tr><tr class="even">
					<td class="name"><a href="#check">check()</a></td>
					<td>Check the form and return a Array of String with the erros ids. If no errors, the Array is Empty.</td>
				</tr><tr class="odd">
					<td class="name"><a href="#reset">reset()</a></td>
					<td>Reset the form</td>
				</tr><tr class="even">
					<td class="name"><a href="#getQuestion">getQuestion()</a></td>
					<td>Return the question for the id parameter</td>
				</tr>
			</table></div>
			
			
	</div>
		
	<br />
	
	<div id="class-constructors" class="member-group section">
		<h2>Constructors</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="FormManager">FormManager()</h3>
				<pre class="definition"><code>public function FormManager()</code></pre>
				<div>To Create an instance of FormManager</div>
				
				
				
			
			
			
			
			</div>
		</div>
	</div>
	<br />
	<div id="class-properties" class="member-group section">
		<h2>Properties</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="tabulation">tabulation</h3>
				<pre class="definition"><code>public function set tabulation(val:Boolean):void<br />public function get tabulation():Boolean</code></pre>
				<div>Enable or disable the automatic tabulation on the form. Default false</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="rollOver">rollOver</h3>
				<pre class="definition"><code>public function get rollOver():Boolean<br />public function set rollOver(value:Boolean):void</code></pre>
				<div>Enable or disable the rollOver on the questions. Default false</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="colorShapeFocus">colorShapeFocus</h3>
				<pre class="definition"><code>public function get colorShapeFocus():int<br />public function set colorShapeFocus(value:int):void</code></pre>
				<div>Define a color for the shape focus of the questions</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="shapeFocus">shapeFocus</h3>
				<pre class="definition"><code>public function get shapeFocus():Boolean<br />public function set shapeFocus(value:Boolean):void</code></pre>
				<div>Enable or disable the shape focus when a question take the focus. Default false</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="buttonConfirm">buttonConfirm</h3>
				<pre class="definition"><code>public function set buttonConfirm(val:Sprite) : void</code></pre>
				<div>Define the button confirm of the form.</div>
				
			
			
			
			
			</div>
		</div>
	</div>
	<br />
	<div id="class-methods" class="member-group section">
		<h2>Methods</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="init">init()</h3>
				<pre class="definition"><code>public function init(containerQuestionsClip:Sprite, xmlForm:XML , tabulation:Boolean = false, pStage:Stage = null)</code></pre>
				<div>Initialize the formManager</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>containerQuestionsClip</code></td><td>The clip contains questions clips on the scene</td></tr>
					<tr><td class="name"><code>xmlForm</code></td><td>The XML describes questions of the form
<p>Exemple xmlForm :
<code>
<form>
				<question	id="login" value="login" type="text" required="true" testType=''  codeError='error5' />
				<question	id="secret" value="secret" type="comboBox" required="true" testType=''  codeError='error5'>
					<item idLibrary="mcComboBoxItem" id="item1" value="1" />
					<item idLibrary="mcComboBoxItem" id="item2" value="2" />
					<item idLibrary="mcComboBoxItem" id="item3" value="2" />
					<item idLibrary="mcComboBoxItem" id="item4" value="2" />
					<item idLibrary="mcComboBoxItem" id="item5" value="2" />
					<item idLibrary="mcComboBoxItem" id="item6" value="2" />
					<item idLibrary="mcComboBoxItem" id="item7" value="2" />
					<item idLibrary="mcComboBoxItem" id="item8" value="2" />
					<item idLibrary="mcComboBoxItem" id="item9" value="2" />
				</question>
				<question	id="secretAnswer" value="secretAnswer" type="text" required="true" testType=''  codeError='error5' />
				<question	id="start" value="start" type="radioButton" required="true" testType=''  codeError='error2'>
					<rep id="radio1" value="1" zoneText="true" />
					<rep id="radio2" value="2" zoneText="true" />
					<rep id="radio3" value="3" zoneText="true" />
				</question>
			</form>
</code></p></td></tr>
					<tr><td class="name"><code>tabulation</code></td><td>To enable or disable the automatic tabulation on the form. True or False.</td></tr>
					<tr><td class="name"><code>pStage</code></td><td>Reference of the stage of the appication.</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="close">close()</h3>
				<pre class="definition"><code>public function close():void</code></pre>
				<div>Close the form (Disable the tabulation)</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="check">check()</h3>
				<pre class="definition"><code>public function check():Array</code></pre>
				<div>Check the form and return a Array of String with the erros ids. If no errors, the Array is Empty.</div>
				
				<dl>
					<dt>Returns:</dt>
					<dd>A array of String with the errors ids</dd>
				</dl>
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="reset">reset()</h3>
				<pre class="definition"><code>public function reset():void</code></pre>
				<div>Reset the form</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="getQuestion">getQuestion()</h3>
				<pre class="definition"><code>public function getQuestion(id:String):AbstractQuestion</code></pre>
				<div>Return the question for the id parameter</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>id</code></td><td>Id of a question of the form</td></tr>
					</table></dd>
				</dl>
				<dl>
					<dt>Returns:</dt>
					<dd>The question corresponding to the id parameter</dd>
				</dl>
				
			
			
			
			
			</div>
		</div>
	</div>
	
	<p class="generated">Page generated: 7:38 pm on June 7, 2010</p>
</div>
</body>
</html>